-
Notifications
You must be signed in to change notification settings - Fork 85
docs: mTLS documentation with example sample #299
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: mTLS documentation with example sample #299
Conversation
|
|
||
| --- | ||
|
|
||
| ## How mTLS Works |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 good writing!
|
|
||
| --- | ||
|
|
||
| ## Complete Working Example |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe add another section of How to enable mTLS?
docs/03-concepts/14-mutual-tls.md
Outdated
|
|
||
| ## Complete Working Example | ||
|
|
||
| For a complete working example with detailed code and configuration, refer to the [helloworld_tls sample](https://github.com/cadence-workflow/cadence-samples/tree/master/new_samples/client_samples/helloworld_tls) in the Cadence samples repository. This sample demonstrates how to: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you update the samples change explaining how this command works?
./cadence-server --env development --zone tls start
| │ All subsequent data is encrypted │ | ||
| │ │ | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a section here explaining how mTLS works with Cadence, explaining creating gRPC options, then the gRPC transport object and Cadence using it (how client is initialized). Leave links to the sample changes and the client repo.
Similarly please leave pointers to server code, explaining how a secure server is started.
Signed-off-by: [email protected] <[email protected]>
Signed-off-by: [email protected] <[email protected]>
Signed-off-by: [email protected] <[email protected]>
Signed-off-by: [email protected] <[email protected]>
Signed-off-by: [email protected] <[email protected]>
Signed-off-by: [email protected] <[email protected]>
Whats new
In mTLS, both the client and server have a certificate, and both sides authenticate using their public/private key pair.
Steps:
Testing Scenarios:
